docs: document searchByEmbedding Local API method#69
Merged
Conversation
Add a vectorizedPayload.searchByEmbedding() section to the README covering params, return shape, the no-reranking behavior, and the findByIds -> searchByEmbedding "more like this" flow. Also drop a redundant inline comment in vectorSearch.ts now that the behavior is documented.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Documents the
searchByEmbeddingLocal API method added in #68, and removes a now-redundant inline comment.vectorizedPayload.searchByEmbedding(params)section — params, return shape, the no-reranking behavior (rerankers need the original query text, unavailable from a raw vector), and thefindByIds({ populateEmbedding: true })→searchByEmbedding()"more like this" flow. Added the method to the Local API methods list and updated thefindByIdsinline example comment to point atsearchByEmbedding().Not included
No changeset — intentionally held back so it can ship in a follow-up PR alongside other pending changes.
Docs/comment only; no behavior change.